<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>ioko-tapestry-commons - </title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
                                                    
<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script>
                                                        
<script type="text/javascript">try {
                var pageTracker = _gat._getTracker("UA-75598-9");
                pageTracker._trackPageview();
                } catch(err) {}</script>
                    </head>
  <body class="composite">
    <div id="banner">
                  <a href="http://tapestry.formos.com/projects/ioko-tapestry-commons/" id="bannerLeft">
    
                                            <img src="images/tapestry-commons.png" alt="" />
    
            </a>
                        <a href="http://www.ioko.com/" id="bannerRight">
    
                                            <img src="images/ioko.png" alt="" />
    
            </a>
            <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
            
  
    
            <div class="xleft">
        Last Published: 2009-09-24
                      </div>
            <div class="xright">      
  

  
    
            
  
    
             Version: 1.6.0-SNAPSHOT
      </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
            
  
    
                   <h5>Sites</h5>
            <ul>
              
    <li class="none">
                    <a href="http://tapestry.formos.com/projects/ioko-tapestry-commons/" class="externalLink">Release Site</a>
          </li>
              
    <li class="none">
                    <a href="http://tapestry.formos.com/nightly/ioko-tapestry-commons/" class="externalLink">Nightly Site</a>
          </li>
          </ul>
              <h5>Modules</h5>
            <ul>
              
    <li class="none">
                    <a href="tapestry-caching/index.html">Tapestry Caching</a>
          </li>
              
    <li class="none">
                    <a href="tapestry-swfObject/index.html">Tapestry Swf Object</a>
          </li>
              
    <li class="none">
                    <a href="tapestry-cacheControl/index.html">Tapestry Cache Control</a>
          </li>
              
    <li class="none">
                    <a href="tapestry-javascript/index.html">Tapestry Javascript</a>
          </li>
              
    <li class="none">
                    <a href="tapestry-jquery/index.html">Tapestry Jquery</a>
          </li>
              
    <li class="none">
                    <a href="tapestry-mixins/index.html">Tapestry Mixins</a>
          </li>
              
    <li class="none">
                    <a href="sample-site/index.html">Example site using ioko-tapestry-commons</a>
          </li>
          </ul>
              <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-info.html">Project Information</a>
                </li>
          </ul>
                        <h5>Developers</h5>
            <ul>
              
    <li class="none">
              <strong>Development Guide</strong>
        </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
            
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2>Development</h2>
<p>To work on this project you need to</p>
<ul><li>Get a tapestry 360 <a class="externalLink" href="http://tapestry.formos.com/svnadmin/">Subversion Account</a></li>
<li>Agree to assign copyright to ioko</li>
</ul>
</div>
<div class="section"><h2>Checking/out and building</h2>
<p>The project is built using Maven 2. So simply check out the trunk and type mvn. That will build it and run the unit tests.</p>
<div class="section"><h3>Common Issues</h3>
<p>It can't find firefox to run the unit tests</p>
<ul><li>The unit tests use selenium to run firefox. You must have firefox 3.x installed<p>It fails on the swfObject tests</p>
</li>
<li>The swfObject tests require firefox has the flash plugin (version 10 or newer)</li>
</ul>
</div>
</div>
<div class="section"><h2>Coding Standards</h2>
<p>Follow the Sun Coding Guidelines - <a class="externalLink" href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html</a></p>
<p>Test everything - we are aiming at 100% test coverage</p>
</div>
<div class="section"><h2>Setting up your IDE</h2>
<p>In IntelliJ just open the pom.xml. In eclipse use mvn eclipse:eclipse. We are using Clover so you can install the Clover plugin for your IDE. The open source license key is in the pom.xml. NOTE you cannot use this key except on open source projects.</p>
</div>
<div class="section"><h2>How to do a release</h2>
<ul><li>First get everyone who is commiting to agree that release is ready</li>
<li>Check test coverage is 100%</li>
<li>On HEAD create a tag called vVERSION_NUMBER - e.g. v_1_2_0</li>
<li>On HEAD search/replace pom's <i>version</i>RELEASE-SNAPSHOT<i>/version</i> to <i>version</i>NEW-SNAPSHOT<i>/version</i>. You have to do tapestry-jquery seperately as it has a different version to indicate which version of jquery it is bundling.</li>
<li>Check out the tag</li>
<li>On the tag search/replace pom's <i>version</i>RELEASE-SNAPSHOT<i>/version</i> to <i>version</i>RELEASE<i>/version</i>. You have to do tapestry-jquery seperately as it has a different version to indicate which version of jquery it is bundling.</li>
<li>Commit to tag</li>
<li>Edit the Release build plan on bamboo to use this tag</li>
<li>Run the release build on bamboo</li>
</ul>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2009
    
          ioko
          
  

  
    
            
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
